<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>shark::DistantModes Class Reference</title>
<script type="text/javaScript" src="search/search.js"></script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js"></script>
<script src="../../mlstyle.js"></script>
<link href="../css/besser.css" rel="stylesheet" type="text/css"/>
</head>
<!-- pretty cool: each body gets an id tag which is the basename of the web page  -->
<!--              and allows for page-specific CSS. this is client-side scripted, -->
<!--              so the id will not yet show up in the served source code -->
<script type="text/javascript">
    jQuery(document).ready(function () {
        var url = jQuery(location).attr('href');
        var pname = url.substr(url.lastIndexOf("/")+1, url.lastIndexOf(".")-url.lastIndexOf("/")-1);
        jQuery('#this_url').html('<strong>' + pname + '</strong>');
        jQuery('body').attr('id', pname);
    });
</script>
<body>
    <div id="shark_old">
        <div id="wrap">
            <div id="header">
                <div id="site-name"><a href="../../sphinx_pages/build/html/index.html">Shark machine learning library</a></div>
                <ul id="nav">
                    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/installation.html">Installation</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/tutorials/tutorials.html">Tutorials</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/benchmark.html">Benchmarks</a>
                    </li>
                    <li class="active">
                        <a href="classes.html">Documentation</a>
                        <ul>
                            <li class="first"></li>
                            <li><a href="../../sphinx_pages/build/html/rest_sources/quickref/quickref.html">Quick references</a></li>
                            <li><a href="classes.html">Class list</a></li>
                            <li class="last"><a href="group__shark__globals.html">Global functions</a></li>
                        </ul>
                    </li>
                </ul>
            </div>
        </div>
    </div>
<div id="doxywrapper">
<!--
    <div id="global_doxytitle">Doxygen<br>Documentation:</div>
-->
    <div id="navrow_wrapper">
<!-- Generated by Doxygen 1.9.8 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceshark.html">shark</a></li><li class="navelem"><a class="el" href="classshark_1_1_distant_modes.html">DistantModes</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="classshark_1_1_distant_modes-members.html">List of all members</a> &#124;
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle"><div class="title">shark::DistantModes Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Creates a set of pattern (each later representing a mode) which than are randomly perturbed to create the data set. The dataset was introduced in Desjardins et al. (2010) (Parallel Tempering for training restricted Boltzmann machines, AISTATS 2010)  
 <a href="classshark_1_1_distant_modes.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_distant_modes_8h_source.html">shark/Unsupervised/RBM/Problems/DistantModes.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4ff22c375621b08c4128254d0cefab02" id="r_a4ff22c375621b08c4128254d0cefab02"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_distant_modes.html#a4ff22c375621b08c4128254d0cefab02">DistantModes</a> (double p=0, unsigned dim=16, unsigned modes=4, unsigned copies=2500, size_t <a class="el" href="namespaceshark.html#af2ab10364feb8a631e0866dcf2f1a4ad">batchSize</a>=0)</td></tr>
<tr class="separator:a4ff22c375621b08c4128254d0cefab02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7557f48d41fe2476fddf7d74e769508b" id="r_a7557f48d41fe2476fddf7d74e769508b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classshark_1_1_unlabeled_data.html">UnlabeledData</a>&lt; RealVector &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_distant_modes.html#a7557f48d41fe2476fddf7d74e769508b">data</a> () const</td></tr>
<tr class="memdesc:a7557f48d41fe2476fddf7d74e769508b"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the generated dataset  <br /></td></tr>
<tr class="separator:a7557f48d41fe2476fddf7d74e769508b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0516b0c3ac1377214d2bebabe0b0f936" id="r_a0516b0c3ac1377214d2bebabe0b0f936"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_distant_modes.html#a0516b0c3ac1377214d2bebabe0b0f936">inputDimension</a> () const</td></tr>
<tr class="memdesc:a0516b0c3ac1377214d2bebabe0b0f936"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the dimensionality of the data  <br /></td></tr>
<tr class="separator:a0516b0c3ac1377214d2bebabe0b0f936"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Creates a set of pattern (each later representing a mode) which than are randomly perturbed to create the data set. The dataset was introduced in Desjardins et al. (2010) (Parallel Tempering for training restricted Boltzmann machines, AISTATS 2010) </p>
<p>The higher the perturbation is the harder it is to classify, but the closer are the modes and thus the easier the data distribution is to learn. </p>

<p class="definition">Definition at line <a class="el" href="_distant_modes_8h_source.html#l00045">45</a> of file <a class="el" href="_distant_modes_8h_source.html">DistantModes.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a4ff22c375621b08c4128254d0cefab02" name="a4ff22c375621b08c4128254d0cefab02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ff22c375621b08c4128254d0cefab02">&#9670;&#160;</a></span>DistantModes()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">shark::DistantModes::DistantModes </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>p</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&#160;</td>
          <td class="paramname"><em>dim</em> = <code>16</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&#160;</td>
          <td class="paramname"><em>modes</em> = <code>4</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&#160;</td>
          <td class="paramname"><em>copies</em> = <code>2500</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>batchSize</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>generates the <a class="el" href="classshark_1_1_distant_modes.html" title="Creates a set of pattern (each later representing a mode) which than are randomly perturbed to create...">DistantModes</a> distribution.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">p</td><td>the probability of changing a input neuron </td></tr>
    <tr><td class="paramname">dim</td><td>the dimensionality of the data. </td></tr>
    <tr><td class="paramname">modes</td><td>the number of modes, should be a multiple of 2 </td></tr>
    <tr><td class="paramname">copies</td><td>the number of disturbed copies for each mode </td></tr>
    <tr><td class="paramname">batchSize</td><td>the size of the batches in which the generated data set is organized </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="_distant_modes_8h_source.html#l00093">93</a> of file <a class="el" href="_distant_modes_8h_source.html">DistantModes.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7557f48d41fe2476fddf7d74e769508b" name="a7557f48d41fe2476fddf7d74e769508b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7557f48d41fe2476fddf7d74e769508b">&#9670;&#160;</a></span>data()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classshark_1_1_unlabeled_data.html">UnlabeledData</a>&lt; RealVector &gt; shark::DistantModes::data </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>returns the generated dataset </p>

<p class="definition">Definition at line <a class="el" href="_distant_modes_8h_source.html#l00099">99</a> of file <a class="el" href="_distant_modes_8h_source.html">DistantModes.h</a>.</p>

</div>
</div>
<a id="a0516b0c3ac1377214d2bebabe0b0f936" name="a0516b0c3ac1377214d2bebabe0b0f936"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0516b0c3ac1377214d2bebabe0b0f936">&#9670;&#160;</a></span>inputDimension()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::size_t shark::DistantModes::inputDimension </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>returns the dimensionality of the data </p>

<p class="definition">Definition at line <a class="el" href="_distant_modes_8h_source.html#l00104">104</a> of file <a class="el" href="_distant_modes_8h_source.html">DistantModes.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/shark/Unsupervised/RBM/Problems/<a class="el" href="_distant_modes_8h_source.html">DistantModes.h</a></li>
</ul>
</div><!-- contents -->
</div>
</body>
</html>
